YarOS

Python 依赖管理基础：虚拟环境与 requirements.txt

在 Python 项目开发中，高效的依赖管理是确保项目稳定性和可复现性的关键。本文将介绍 Python 虚拟环境的重要性，以及如何使用 pip freeze 和 pip-tools 来管理和补全项目依赖文件 requirements.txt。

在 Python 开发中，为每个项目创建独立的虚拟环境 (Virtual Environment) 是最佳实践。

隔离性： 虚拟环境为每个项目提供一个独立的 Python 运行时环境。这意味着你在一个虚拟环境中安装的包不会影响到其他项目或系统的全局 Python 环境。
避免冲突： 不同的项目可能需要相同库的不同版本。虚拟环境可以避免这些版本冲突，确保每个项目都能使用它所需的特定依赖版本。
可复现性： 通过虚拟环境和依赖文件，你可以轻松地在不同的机器或环境中复现项目的开发环境，确保团队成员和部署环境的一致性。

在 PyCharm 中创建：
1. 打开 PyCharm 项目。
2. 进入 PyCharm -> Settings (macOS) 或 File -> Settings (Windows/Linux)。
3. 导航到 Project: [Your Project Name] -> Python Interpreter。
4. 点击解释器下拉菜单旁边的齿轮图标 ⚙️，然后选择 Add Interpreter... -> Add Local Interpreter。
5. 选择 Virtualenv Environment，并选择 New environment 来创建一个新的虚拟环境，指定其基于的 Python 版本。PyCharm 会自动配置并激活它。

在命令行中创建 (通用方法)：

# 使用 Python 3.x 创建名为 .venv 的虚拟环境
python3 -m venv .venv

激活虚拟环境： 创建后，你需要激活它才能在当前终端会话中使用：
```
# macOS / Linux
source .venv/bin/activate

# Windows (Command Prompt)
.venv\Scripts\activate.bat

# Windows (PowerShell)
.venv\Scripts\Activate.ps1
```
激活成功后，你的终端提示符前面通常会显示虚拟环境的名称（例如 (.venv) 或 (your_env_name)）。

无论你通过何种方式激活了虚拟环境，都可以使用 deactivate 命令来退出：

requirements.txt 文件用于记录项目的所有依赖包及其精确版本。这对于项目的可复现性和团队协作至关重要。

如果你的 requirements.txt 文件不完整（例如，只包含部分依赖，或者缺少传递性依赖），你可以使用以下方法来补全它：

pip freeze 命令会列出当前激活的 Python 环境中所有已安装的包及其精确版本。

确保你已激活了项目的虚拟环境。
打开 PyCharm 的集成终端 (它通常会自动激活虚拟环境)。
运行以下命令并重定向输出：
```
pip freeze > requirements.txt
```
执行此命令后，当前虚拟环境中所有包的列表将被写入到你项目根目录下的 requirements.txt 文件中，覆盖原有内容。

pip-tools 是一组工具，用于更精确地管理 Python 依赖，它能确保构建的可复现性，并区分直接依赖和传递性依赖。

安装 pip-tools： 在你的虚拟环境中安装 pip-tools：
```
pip install pip-tools
```
创建 requirements.in 文件： 在你的项目根目录创建一个名为 requirements.in 的文件。在这个文件中，只列出你的直接依赖（也就是你在代码中直接 import 或显式使用的顶级库）。例如：
```
fastapi
pandas
openpyxl
# ... 其他你直接使用的顶级库 ...
```
编译生成 requirements.txt： 在 PyCharm 的终端中运行以下命令：
```
pip-compile requirements.in
```
这个命令会读取 requirements.in 文件，解析所有直接和传递性依赖，然后生成一个包含精确版本号的 requirements.txt 文件。
同步你的环境：
```
pip-sync
```
这个命令会根据 requirements.txt 中的内容来同步你的虚拟环境：它会安装 requirements.txt 中列出的所有包，并卸载环境中那些不在列表中的包。

总结： 虚拟环境是 Python 依赖管理的基石。pip freeze 提供快速快照，而 pip-tools 则提供更精细、可复现的依赖管理，你可以根据项目需求选择最适合的方法。